/*
 * Copyright (C) 2010 Graham Allan
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package edu.strath.cis.grallan.findbugs.adaptiveranking.population;

import edu.strath.cis.grallan.findbugs.adaptiveranking.UserDesignationToPositivesMap;
import edu.umd.cs.findbugs.BugInstance;
import edu.umd.cs.findbugs.internalAnnotations.DottedClassName;

/**
 * @author Graham Allan (grallan@cis.strath.ac.uk)
 */
public class ClassPopulation extends AbstractPopulation {

	private final String className;

	/**
	 * Creates a Population for all alerts within a given class.
	 * 
	 * @see #populationOf(String)
	 */
	private ClassPopulation(@DottedClassName String className, UserDesignationToPositivesMap mapper) {
		super(mapper);
		this.className = className;
	}

	public static ClassPopulation populationOf(@DottedClassName String className) {
		return new ClassPopulation(className, new UserDesignationToPositivesMap());
	}

	@Override
	protected void checkAlert(BugInstance bugAlert) throws NullPointerException, PopulationException {
		super.checkAlert(bugAlert);

		String thatClass = bugAlert.getPrimaryClass().getClassName();

		if (!this.className.equals(thatClass))
			throw new PopulationException("This population is for alerts within the class [" + className
					+ "]. It is invalid to add a bug alert from the class [" + thatClass + "].");
	}

	public String populationDescriptor() {
		return className;
	}

}
